/*
 * MIT License
 *
 * Copyright (c) 2020 wen.gu <454727014@qq.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/******************************************************************************
 * Name: dog_communication_service_port.h
 *
 * Purpose: communication port interface define(as json style) for service side
 *
 * Developer:
 *   wen.gu , 2020-08-19
 *
 * TODO:
 *
 *****************************************************************************/

/******************************************************************************
 **    INCLUDES
 ******************************************************************************/
#ifndef __DOG_COMMUNICATION_SERVICE_PORT_H__
#define __DOG_COMMUNICATION_SERVICE_PORT_H__
#include <functional>
#include <memory>

#include "dog_component.h"
#include "dog_json.h"
/******************************************************************************
 **    MACROS
 ******************************************************************************/

#define COM_SRV_PORT_COMP_TYPE "_COMSRVPORT_"   

/******************************************************************************
 **    TYPE DEFINITIONS
 ******************************************************************************/
namespace dog
{



/** parameter: 
 * [1]: method name, 
 * [2]: method param, 
 * [3]: method reply  
 */
using CommunicationServiceHandler = std::function<void(const char*, const Value&, Value&)>;



struct ComSrvPortCreateParam: public ComponentCreateParam
{
    std::string srvName = ""; /** service name*/
    std::string comType = ""; /** the type(or name) of communication port */
    EXTEND_COMP_CREATE_PARAM(ComSrvPortCreateParam, COM_SRV_PORT_COMP_TYPE);
};
/******************************************************************************
 **    CLASSES/FUNCTIONS DEFINITIONS
 ******************************************************************************/

class CommunicationServicePort : public Component
{
public:
    CommunicationServicePort(const std::string& compName, const std::string& version)
        :Component(compName, version)
    {
        /** todo something */
    }
    virtual ~CommunicationServicePort(){ /**todo something */}
public:
    /** service set this to observer method call */
    virtual bool setObserver(CommunicationServiceHandler hdl) = 0; /** for sync method call */
    virtual void emitSignal(const char* name, const Value& val) = 0; /** async */
    virtual bool offerService() = 0; /** after this call, current instance will be really visible by others */
    virtual bool stopService() = 0; /** after this call, current instance stop offer service for others */
};


} /** namespace dog */

#endif /** !__DOG_COMMUNICATION_SERVICE_PORT_H__ */

